API

Human resource APIs

GET human-resources/work-days/{workDayId}

Details for provided work hour log

HTTP method GET
URI https://api.rambase.net/human-resources/work-days/{workDayId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {workDayId} Workday identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 2075, version 30

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<Workday>
2
     <WorkdayId
WorkdayId

Workday identifier

>{Integer}</WorkdayId>
3
     <Status
Status

Status of workday

Possible domain values can be found here

>{Integer}</Status>
4
     <Date
Date

Date of workday

>{Date}</Date>
5
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
6
     <Description
Description

Description for the workday according to the special time type descriptions

>{String}</Description>
7
     <Totals
Totals

This field is greyed out because it is an expandable field. You have to add $expand=Totals in your request URI to get this field

>
8
          <NumberOfAllowances
NumberOfAllowances

Total number of allowances in this work hour log.

This field is greyed out because it is an expandable field. You have to add $expand=Totals in your request URI to get this field

>{Integer}</NumberOfAllowances>
9
          <NumberOfAdjustments
NumberOfAdjustments

Total number of adjustments in this work hour log.

This field is greyed out because it is an expandable field. You have to add $expand=Totals in your request URI to get this field

>{Integer}</NumberOfAdjustments>
10
          <NumberOfPeriods
NumberOfPeriods

Total number of periods in this work hour log.

This field is greyed out because it is an expandable field. You have to add $expand=Totals in your request URI to get this field

>{Integer}</NumberOfPeriods>
11
          <ScheduledWorkingHours
ScheduledWorkingHours

Total scheduled/expected hours for the employee at given date. These hours is extracted from the work arrangement.

This field is greyed out because it is an expandable field. You have to add $expand=Totals in your request URI to get this field

>{Decimal}</ScheduledWorkingHours>
12
          <WorkHours
WorkHours

Total hours of actual work hours for the work hour log. Sum of ordinary work, overtime and paid leave.

This field is greyed out because it is an expandable field. You have to add $expand=Totals in your request URI to get this field

>{Decimal}</WorkHours>
13
          <RegularHours
RegularHours

Total work time, in hours, for all periods in this work hour log.

This field is greyed out because it is an expandable field. You have to add $expand=Totals in your request URI to get this field

>{Decimal}</RegularHours>
14
          <OvertimeHours
OvertimeHours

Total overtime, in hours, of all periods in this work hour log.

This field is greyed out because it is an expandable field. You have to add $expand=Totals in your request URI to get this field

>{Decimal}</OvertimeHours>
15
          <PaidAbscenceHours
PaidAbscenceHours

Total paid leave/absence, in hours, for all periods in this work hour log. Ex. vacation, paid sick leave and/or parental leave.

This field is greyed out because it is an expandable field. You have to add $expand=Totals in your request URI to get this field

>{Decimal}</PaidAbscenceHours>
16
          <UnpaidAbscenceHours
UnpaidAbscenceHours

Total unpaid leave/absence, in hours, for all periods in this work hour log. Ex. day off or unpaid short time leave.

This field is greyed out because it is an expandable field. You have to add $expand=Totals in your request URI to get this field

>{Decimal}</UnpaidAbscenceHours>
17
          <LunchHours
LunchHours

Total unpaid lunch, in hours, for all periods in this work hour log. Note that unpaid lunch is only calculated if the sum of work time, overtime and paid leave exceeds 5.5 hours.

This field is greyed out because it is an expandable field. You have to add $expand=Totals in your request URI to get this field

>{Decimal}</LunchHours>
18
          <FlexHours
FlexHours

Change/difference in flextime account. Calculated by substracting ordinary work and paid- and unpaid absence from scheduled hours. Will only be set if status is 4 or more, and work arrangement allows flexitime. Will not be set if work hour log contains any periods with partial- or graded sick leave.

This field is greyed out because it is an expandable field. You have to add $expand=Totals in your request URI to get this field

>{Decimal}</FlexHours>
19
     </Totals>
20
     <TotalsIncludingUnapproved
TotalsIncludingUnapproved

This field is greyed out because it is an expandable field. You have to add $expand=TotalsIncludingUnapproved in your request URI to get this field

>
21
          <WorkHours
WorkHours

Total hours of actual work hours for the work hour log. Sum of ordinary work, overtime and paid leave.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsIncludingUnapproved in your request URI to get this field

>{Decimal}</WorkHours>
22
          <RegularHours
RegularHours

Total work time, in hours, for all periods in this work hour log.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsIncludingUnapproved in your request URI to get this field

>{Decimal}</RegularHours>
23
          <OvertimeHours
OvertimeHours

Total overtime, in hours, of all periods in this work hour log.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsIncludingUnapproved in your request URI to get this field

>{Decimal}</OvertimeHours>
24
          <PaidAbscenceHours
PaidAbscenceHours

Total paid leave/absence, in hours, for all periods in this work hour log. Ex. vacation, paid sick leave and/or parental leave.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsIncludingUnapproved in your request URI to get this field

>{Decimal}</PaidAbscenceHours>
25
          <UnpaidAbscenceHours
UnpaidAbscenceHours

Total unpaid leave/absence, in hours, for all periods in this work hour log. Ex. day off or unpaid short time leave.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsIncludingUnapproved in your request URI to get this field

>{Decimal}</UnpaidAbscenceHours>
26
          <LunchHours
LunchHours

Total unpaid lunch, in hours, for all periods in this work hour log. Note that unpaid lunch is only calculated if the sum of work time, overtime and paid leave exceeds 5.5 hours.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsIncludingUnapproved in your request URI to get this field

>{Decimal}</LunchHours>
27
          <FlexHours
FlexHours

Change/difference in flextime account. Calculated by substracting ordinary work and paid- and unpaid absence from scheduled hours. Will only be set if status is 4 or more, and work arrangement allows flexitime. Will not be set if work hour log contains any periods with partial- or graded sick leave.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsIncludingUnapproved in your request URI to get this field

>{Decimal}</FlexHours>
28
     </TotalsIncludingUnapproved>
29
     <Employee>
30
          <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
31
          <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
32
     </Employee>
33
     <ScheduledWorkPeriods
ScheduledWorkPeriods

This field is greyed out because it is an expandable field. You have to add $expand=ScheduledWorkPeriods in your request URI to get this field

>
34
          <ScheduledWorkPeriod
ScheduledWorkPeriod

This field is greyed out because it is an expandable field. You have to add $expand=ScheduledWorkPeriods in your request URI to get this field

>
35
               <ScheduledWorkPeriodId
ScheduledWorkPeriodId

Scheduled work period identifier

This field is greyed out because it is an expandable field. You have to add $expand=ScheduledWorkPeriods in your request URI to get this field

>{Integer}</ScheduledWorkPeriodId>
36
               <StartTime
StartTime

Start time of scheduled work period

This field is greyed out because it is an expandable field. You have to add $expand=ScheduledWorkPeriods in your request URI to get this field

>{Time}</StartTime>
37
               <EndTime
EndTime

End time of scheduled work period

This field is greyed out because it is an expandable field. You have to add $expand=ScheduledWorkPeriods in your request URI to get this field

>{Time}</EndTime>
38
               <ScheduledWorkPeriodLink
ScheduledWorkPeriodLink

Scheduled work period reference

This field is greyed out because it is an expandable field. You have to add $expand=ScheduledWorkPeriods in your request URI to get this field

>{String}</ScheduledWorkPeriodLink>
39
          </ScheduledWorkPeriod>
40
     </ScheduledWorkPeriods>
41
     <WorkSchedule
WorkSchedule

Work schedule used for calculating totals in this work hour log. Which work schedule to use is based on employee and date.

>
42
          <WorkScheduleId
WorkScheduleId

Work schedule identifier

>{Integer}</WorkScheduleId>
43
          <WorkAgreement>
44
               <WorkAgreementId
WorkAgreementId

Work agreement identifier

>{Integer}</WorkAgreementId>
45
               <WorkAgreementLink
WorkAgreementLink

Work agreement reference

>{String}</WorkAgreementLink>
46
          </WorkAgreement>
47
          <WorkScheduleLink
WorkScheduleLink

Work schedule reference

>{String}</WorkScheduleLink>
48
     </WorkSchedule>
49
     <SelfCertification>
50
          <SelfCertificationId
SelfCertificationId

Self certificate identifier

>{Integer}</SelfCertificationId>
51
          <SelfCertificationLink
SelfCertificationLink

Self certificate reference

>{String}</SelfCertificationLink>
52
     </SelfCertification>
53
     <WorkMonth>
54
          <WorkMonthId
WorkMonthId

Work month identifier

>{Integer}</WorkMonthId>
55
          <WorkMonthLink
WorkMonthLink

Work month reference

>{String}</WorkMonthLink>
56
     </WorkMonth>
57
     <LastTenWorkPeriods
LastTenWorkPeriods

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

>
58
          <WorkPeriod
WorkPeriod

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

>
59
               <WorkPeriodId
WorkPeriodId

Work period, allowance or adjustment identifier

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

>{Integer}</WorkPeriodId>
60
               <CreatedAt
CreatedAt

Date and time of creation

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

>{Datetime}</CreatedAt>
61
               <Status
Status

Status of work period, allowance or adjustment

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

>{String}</Status>
62
               <IsIn
IsIn

Type of work period, allowance or adjustment.

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

>{Boolean}</IsIn>
63
               <TimeType
TimeType

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

>
64
                    <TimeTypeId
TimeTypeId

Time type identifier

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

>{Integer}</TimeTypeId>
65
                    <OvertimePercent
OvertimePercent

Overtime percentage

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

>{Integer}</OvertimePercent>
66
                    <Category
Category

Category of the time type

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

>{Integer}</Category>
67
                    <Description
Description

Description of the time type

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

>{String}</Description>
68
                    <TimeTypeLink
TimeTypeLink

Reference to the time type

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

>{String}</TimeTypeLink>
69
               </TimeType>
70
               <Source
Source

Source of the period data

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

>{String}</Source>
71
               <Note
Note

Note/comment of the work period, allowance or adjustment

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

>{String}</Note>
72
               <Date
Date

Date of the work period, allowance or adjustment . This date might differ from the date of the workday if the period is across midnight.

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

>{Date}</Date>
73
               <Start
Start

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

>
74
                    <Time
Time

Start time of work period or allowance

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

>{Time}</Time>
75
                    <Site
Site

Site at start time of work period

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

>{String}</Site>
76
               </Start>
77
               <End
End

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

>
78
                    <Time
Time

End time of work period or allowance

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

>{Time}</Time>
79
                    <Site
Site

Site at end time of work period

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

>{String}</Site>
80
               </End>
81
               <Total
Total

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

>
82
                    <Hours
Hours

Total time, in hours, of the work period, allowance or adjustment. Calculated by subtracting the start time from the end time.

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

>{Decimal}</Hours>
83
                    <Time
Time

Total time, in hours and minutes, of the period. Calculated by subtracting the start time from the end time.

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

>{Time}</Time>
84
               </Total>
85
               <ShortTermAbsence
ShortTermAbsence

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

>
86
                    <ShortTermAbsenceId
ShortTermAbsenceId

Short-term absence identifier

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

>{Integer}</ShortTermAbsenceId>
87
                    <ShortTermAbsenceLink
ShortTermAbsenceLink

Short-term absence reference

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

>{String}</ShortTermAbsenceLink>
88
               </ShortTermAbsence>
89
               <WorkPeriodLink
WorkPeriodLink

Work period, allowance or adjustment reference

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

>{String}</WorkPeriodLink>
90
          </WorkPeriod>
91
     </LastTenWorkPeriods>
92
</Workday>
1
{
2
     "workday": {
3
          "workdayId
WorkdayId

Workday identifier

": "{Integer}",
4
          "status
Status

Status of workday

Possible domain values can be found here

": "{Integer}",
5
          "date
Date

Date of workday

": "{Date}",
6
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
7
          "description
Description

Description for the workday according to the special time type descriptions

": "{String}",
8
          "totals
Totals

This field is greyed out because it is an expandable field. You have to add $expand=Totals in your request URI to get this field

": {
9
               "numberOfAllowances
NumberOfAllowances

Total number of allowances in this work hour log.

This field is greyed out because it is an expandable field. You have to add $expand=Totals in your request URI to get this field

": "{Integer}",
10
               "numberOfAdjustments
NumberOfAdjustments

Total number of adjustments in this work hour log.

This field is greyed out because it is an expandable field. You have to add $expand=Totals in your request URI to get this field

": "{Integer}",
11
               "numberOfPeriods
NumberOfPeriods

Total number of periods in this work hour log.

This field is greyed out because it is an expandable field. You have to add $expand=Totals in your request URI to get this field

": "{Integer}",
12
               "scheduledWorkingHours
ScheduledWorkingHours

Total scheduled/expected hours for the employee at given date. These hours is extracted from the work arrangement.

This field is greyed out because it is an expandable field. You have to add $expand=Totals in your request URI to get this field

": "{Decimal}",
13
               "workHours
WorkHours

Total hours of actual work hours for the work hour log. Sum of ordinary work, overtime and paid leave.

This field is greyed out because it is an expandable field. You have to add $expand=Totals in your request URI to get this field

": "{Decimal}",
14
               "regularHours
RegularHours

Total work time, in hours, for all periods in this work hour log.

This field is greyed out because it is an expandable field. You have to add $expand=Totals in your request URI to get this field

": "{Decimal}",
15
               "overtimeHours
OvertimeHours

Total overtime, in hours, of all periods in this work hour log.

This field is greyed out because it is an expandable field. You have to add $expand=Totals in your request URI to get this field

": "{Decimal}",
16
               "paidAbscenceHours
PaidAbscenceHours

Total paid leave/absence, in hours, for all periods in this work hour log. Ex. vacation, paid sick leave and/or parental leave.

This field is greyed out because it is an expandable field. You have to add $expand=Totals in your request URI to get this field

": "{Decimal}",
17
               "unpaidAbscenceHours
UnpaidAbscenceHours

Total unpaid leave/absence, in hours, for all periods in this work hour log. Ex. day off or unpaid short time leave.

This field is greyed out because it is an expandable field. You have to add $expand=Totals in your request URI to get this field

": "{Decimal}",
18
               "lunchHours
LunchHours

Total unpaid lunch, in hours, for all periods in this work hour log. Note that unpaid lunch is only calculated if the sum of work time, overtime and paid leave exceeds 5.5 hours.

This field is greyed out because it is an expandable field. You have to add $expand=Totals in your request URI to get this field

": "{Decimal}",
19
               "flexHours
FlexHours

Change/difference in flextime account. Calculated by substracting ordinary work and paid- and unpaid absence from scheduled hours. Will only be set if status is 4 or more, and work arrangement allows flexitime. Will not be set if work hour log contains any periods with partial- or graded sick leave.

This field is greyed out because it is an expandable field. You have to add $expand=Totals in your request URI to get this field

": "{Decimal}"
20
          },
21
          "totalsIncludingUnapproved
TotalsIncludingUnapproved

This field is greyed out because it is an expandable field. You have to add $expand=TotalsIncludingUnapproved in your request URI to get this field

": {
22
               "workHours
WorkHours

Total hours of actual work hours for the work hour log. Sum of ordinary work, overtime and paid leave.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsIncludingUnapproved in your request URI to get this field

": "{Decimal}",
23
               "regularHours
RegularHours

Total work time, in hours, for all periods in this work hour log.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsIncludingUnapproved in your request URI to get this field

": "{Decimal}",
24
               "overtimeHours
OvertimeHours

Total overtime, in hours, of all periods in this work hour log.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsIncludingUnapproved in your request URI to get this field

": "{Decimal}",
25
               "paidAbscenceHours
PaidAbscenceHours

Total paid leave/absence, in hours, for all periods in this work hour log. Ex. vacation, paid sick leave and/or parental leave.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsIncludingUnapproved in your request URI to get this field

": "{Decimal}",
26
               "unpaidAbscenceHours
UnpaidAbscenceHours

Total unpaid leave/absence, in hours, for all periods in this work hour log. Ex. day off or unpaid short time leave.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsIncludingUnapproved in your request URI to get this field

": "{Decimal}",
27
               "lunchHours
LunchHours

Total unpaid lunch, in hours, for all periods in this work hour log. Note that unpaid lunch is only calculated if the sum of work time, overtime and paid leave exceeds 5.5 hours.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsIncludingUnapproved in your request URI to get this field

": "{Decimal}",
28
               "flexHours
FlexHours

Change/difference in flextime account. Calculated by substracting ordinary work and paid- and unpaid absence from scheduled hours. Will only be set if status is 4 or more, and work arrangement allows flexitime. Will not be set if work hour log contains any periods with partial- or graded sick leave.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsIncludingUnapproved in your request URI to get this field

": "{Decimal}"
29
          },
30
          "employee": {
31
               "employeeId
EmployeeId

Employee identifier

": "{Integer}",
32
               "employeeLink
EmployeeLink

Employee reference

": "{String}"
33
          },
34
          "scheduledWorkPeriods
ScheduledWorkPeriods

This field is greyed out because it is an expandable field. You have to add $expand=ScheduledWorkPeriods in your request URI to get this field

": [
35
               {
36
                    "scheduledWorkPeriodId
ScheduledWorkPeriodId

Scheduled work period identifier

This field is greyed out because it is an expandable field. You have to add $expand=ScheduledWorkPeriods in your request URI to get this field

": "{Integer}",
37
                    "startTime
StartTime

Start time of scheduled work period

This field is greyed out because it is an expandable field. You have to add $expand=ScheduledWorkPeriods in your request URI to get this field

": "{Time}",
38
                    "endTime
EndTime

End time of scheduled work period

This field is greyed out because it is an expandable field. You have to add $expand=ScheduledWorkPeriods in your request URI to get this field

": "{Time}",
39
                    "scheduledWorkPeriodLink
ScheduledWorkPeriodLink

Scheduled work period reference

This field is greyed out because it is an expandable field. You have to add $expand=ScheduledWorkPeriods in your request URI to get this field

": "{String}"
40
               }
41
          ],
42
          "workSchedule
WorkSchedule

Work schedule used for calculating totals in this work hour log. Which work schedule to use is based on employee and date.

": {
43
               "workScheduleId
WorkScheduleId

Work schedule identifier

": "{Integer}",
44
               "workAgreement": {
45
                    "workAgreementId
WorkAgreementId

Work agreement identifier

": "{Integer}",
46
                    "workAgreementLink
WorkAgreementLink

Work agreement reference

": "{String}"
47
               },
48
               "workScheduleLink
WorkScheduleLink

Work schedule reference

": "{String}"
49
          },
50
          "selfCertification": {
51
               "selfCertificationId
SelfCertificationId

Self certificate identifier

": "{Integer}",
52
               "selfCertificationLink
SelfCertificationLink

Self certificate reference

": "{String}"
53
          },
54
          "workMonth": {
55
               "workMonthId
WorkMonthId

Work month identifier

": "{Integer}",
56
               "workMonthLink
WorkMonthLink

Work month reference

": "{String}"
57
          },
58
          "lastTenWorkPeriods
LastTenWorkPeriods

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

": [
59
               {
60
                    "workPeriodId
WorkPeriodId

Work period, allowance or adjustment identifier

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

": "{Integer}",
61
                    "createdAt
CreatedAt

Date and time of creation

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

": "{Datetime}",
62
                    "status
Status

Status of work period, allowance or adjustment

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

": "{String}",
63
                    "isIn
IsIn

Type of work period, allowance or adjustment.

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

": "{Boolean}",
64
                    "timeType
TimeType

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

": {
65
                         "timeTypeId
TimeTypeId

Time type identifier

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

": "{Integer}",
66
                         "overtimePercent
OvertimePercent

Overtime percentage

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

": "{Integer}",
67
                         "category
Category

Category of the time type

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

": "{Integer}",
68
                         "description
Description

Description of the time type

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

": "{String}",
69
                         "timeTypeLink
TimeTypeLink

Reference to the time type

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

": "{String}"
70
                    },
71
                    "source
Source

Source of the period data

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

": "{String}",
72
                    "note
Note

Note/comment of the work period, allowance or adjustment

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

": "{String}",
73
                    "date
Date

Date of the work period, allowance or adjustment . This date might differ from the date of the workday if the period is across midnight.

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

": "{Date}",
74
                    "start
Start

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

": {
75
                         "time
Time

Start time of work period or allowance

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

": "{Time}",
76
                         "site
Site

Site at start time of work period

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

": "{String}"
77
                    },
78
                    "end
End

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

": {
79
                         "time
Time

End time of work period or allowance

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

": "{Time}",
80
                         "site
Site

Site at end time of work period

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

": "{String}"
81
                    },
82
                    "total
Total

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

": {
83
                         "hours
Hours

Total time, in hours, of the work period, allowance or adjustment. Calculated by subtracting the start time from the end time.

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

": "{Decimal}",
84
                         "time
Time

Total time, in hours and minutes, of the period. Calculated by subtracting the start time from the end time.

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

": "{Time}"
85
                    },
86
                    "shortTermAbsence
ShortTermAbsence

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

": {
87
                         "shortTermAbsenceId
ShortTermAbsenceId

Short-term absence identifier

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

": "{Integer}",
88
                         "shortTermAbsenceLink
ShortTermAbsenceLink

Short-term absence reference

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

": "{String}"
89
                    },
90
                    "workPeriodLink
WorkPeriodLink

Work period, allowance or adjustment reference

This field is greyed out because it is an expandable field. You have to add $expand=LastTenWorkPeriods in your request URI to get this field

": "{String}"
91
               }
92
          ]
93
     }
94
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 101015 HTTP 404 Permission not found
Error 101420 HTTP 404 Setting definition not found
Error 100511 HTTP 400 Invalid date